/**
 *
 *  Copyright (c) 2011, AstroDAbis
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without modification,
 *  are permitted provided that the following conditions are met:
 *
 *      * Redistributions of source code must retain the above copyright notice,
 *        this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright notice,
 *        this list of conditions and the following disclaimer in the documentation
 *        and/or other materials provided with the distribution.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 *  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 *  OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jiscinvolve.astrodabis.mallow.model.tap;

/**
 * Class to represent a row in a TAP service.
 * @todo Refactor this as TapRow.
 *
 */
public class TapObject
    {

    /**
     * Compound identifier delimiter.
     *
     */
    public static final String DELIMITER = ":" ;

    /**
     * Public constructor.
     *
     */
    public TapObject(TapTable table, String key)
        {
        this.key   = key ;
        this.table = table ;
        }

    /**
     * Get the compound identifier.
     * This is a combination of the TAP table identifier and the object identifier (primary key) within the table.
     *
     */
    public String ident()
        {
        StringBuilder builder = new StringBuilder();
        builder.append(
            this.table().ident()
            );
        builder.append(
            DELIMITER
            );
        builder.append(
            this.key()
            );
        return builder.toString();
        }

    /**
     * The parent TapService.
     *
     */
    public TapService service()
        {
        return this.table.service() ;
        }

    /**
     * The parent TapTable.
     *
     */
    private TapTable table ;

    /**
     * The parent TapTable.
     *
     */
    public TapTable table()
        {
        return this.table ;
        }

    /**
     * The primary key identifier within the TapTable.
     *
     */
    private String key ;

    /**
     * The primary key identifier within the TapTable.
     *
     */
    public String key()
        {
        return this.key ;
        }

    }

